home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d7 / jlblink.arc / JLBLNKCS.TXT < prev    next >
Text File  |  1990-10-18  |  10KB  |  361 lines
  1.  
  2.   Communication Link Script Commands
  3.  
  4.   All of the script files the Communication Link executes automatically are
  5.   Command Script files.  A Command Script is an ASCII file that contains one
  6.   or more Communication Link Script Commands per file.  Each Script Command
  7.   must be on a line by itself.  Comments can appear on any line that does
  8.   not contain a Script Command.  If you should need to edit or write an
  9.   additional Command Script, the following list of Communication Link Script
  10.   Commands must be used.
  11.  
  12.   A detailed explanation of how each command is used follows the list.
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.      Blink           Execute a Blink command.
  23.      Capture         Turn on/off Session Capture.
  24.      Echo            Turn on/off echo status.
  25.      Getc            Get a character from the communication port
  26.                      that matches the sample character.
  27.      Gets            Get a string from the communications port that
  28.                      matches the sample string.
  29.      Puts            Print a string of characters to the
  30.                      communications port.
  31.      Screen          Turn on/off, or clear the display of
  32.                      characters in the Communication Link Window.
  33.      Show            Print a string to the Communication Link
  34.                      Window.
  35.      Silence         Wait for so many seconds of silence.
  36.      Wait            Wait for so many seconds.
  37.      Watch           Watch for string before proceeding to next
  38.                      command.
  39.  
  40.  
  41.  
  42.   The syntax of all Script Commands is:
  43.  
  44.      command "action or string"
  45.  
  46.   Where "command" is the name of the Script Command (which can be in any
  47.   case) and "action or string" is an action or string which is always
  48.   enclosed in double quotes (").
  49.  
  50.   The Script Command string can contain any legal C escape sequence, for
  51.   instance, to include an ASCII Carriage Return in your string, use the C
  52.   escape sequence of "\r".  The action can be any mixture of case.
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.   The Blink Command
  63.  
  64.   The Blink command is used to execute any of the following Communication
  65.   Link commands:
  66.  
  67.      Blink Option    Command
  68.      ------------    -------
  69.      Messages        Conference Messages <Alt-B><C>
  70.      Mail            Mail Memos <Alt-B><M>
  71.      Up              UpBlink Script(s) <Alt-B><U>
  72.      Down            DownBlink Script(s) <Alt-B><D>
  73.  
  74.   For example, to Blink all your new messages, you would include the
  75.   following line in your Command Script file:
  76.  
  77.      Blink "MESSAGES"
  78.  
  79.  
  80.  
  81.  
  82.   The Capture Command
  83.  
  84.   The Capture command is used to turn on and off the Session Capture or to
  85.   capture the BIX Scratchpad to disk.  There are three options for the
  86.   Capture command and they are "ON", "OFF", or "FILENAME.EXT".  For example,
  87.   to turn on the Session Capture, you would include the following line in
  88.   your Command Script file:
  89.  
  90.      Capture "ON"
  91.  
  92.   To Capture the contents of the BIX Scratchpad, you would include a line
  93.   such as:
  94.  
  95.      Capture "C:\JLBLINK\BLNEW\NEWMESS.TXT"
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.   The Echo Command
  103.  
  104.   The Echo command is used to report to the Communication Link the current
  105.   echo state of the path.  There are two options for the Echo command and
  106.   they are "ON" which states the path does echo characters and "OFF" which
  107.   states the path does not echo characters.  You should use this command if
  108.   you change the echo state of the path while executing a Command Script.
  109.   For example, if you change the echo state of the path so it no longer
  110.   echoes characters, you must include the following line in your Command
  111.   Script after the line that changes the echo state:
  112.  
  113.      Echo "OFF"
  114.  
  115.   The above example tells the Communication Link that the path does not echo
  116.   characters so it needs to.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.   The Echo Command (Continued)
  123.  
  124.   NOTE:  "Echo" refers to displaying, on the screen, the characters you type
  125.   or transmit.  The term "path" refers to the complete communications link
  126.   to BIX.  For instance, you will more than likely be accessing BIX through
  127.   the use of an intelligent modem which can alter the echo state of the path
  128.   and you may also be accessing BIX through a commercial wide area network
  129.   which can also alter the echo state of the path.
  130.  
  131.   If the echo state of the path changes during the execution of a Command
  132.   Script or because of something you have done manually, you *must* tell the
  133.   Communication Link what the current echo state is.
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.   The Getc Command
  143.  
  144.   The Getc command is used to halt the execution of a Command Script until
  145.   the Communication Link receives a character that matches the sample
  146.   character.  For example, the following Script Command will halt the
  147.   execution of the Command Script until the Communication Link receives a
  148.   question mark or the value of the Setup Parameter "Time Out" is exceeded:
  149.  
  150.      Getc "?"
  151.  
  152.   The Communication Link will display an annunciator in the bottom status
  153.   line of the Communication Link Window advising you that it is currently
  154.   waiting to receive the sample character.  You may abort the wait by
  155.   pressing <^C>.  If the Communication Link has to wait longer than the
  156.   value of the Setup Parameter "Time Out" for activity, it will abort the
  157.   wait automatically and fail the command.
  158.  
  159.  
  160.  
  161.  
  162.   The Gets Command
  163.  
  164.   The Gets command is used to halt the execution of a Command Script until
  165.   the Communication Link receives a string of characters that matches the
  166.   sample string or the value of the Setup Parameter "Time Out" is exceeded.
  167.   For example, the following Script Command will halt the execution of a
  168.   Command Script until it receives the string "Welcome":
  169.  
  170.      Gets "Welcome"
  171.  
  172.   The Communication Link will display an annunciator in the bottom status
  173.   line of the Communication Link Window advising you that it is currently
  174.   waiting to receive a string that matches the sample string.  You may abort
  175.   the wait by pressing <^C>.  If the Communication Link has to wait longer
  176.   than the value of the Setup Parameter "Time Out" for activity, it will
  177.   abort the wait automatically and fail the command.
  178.  
  179.  
  180.  
  181.  
  182.   The Puts Command
  183.  
  184.   The Puts command will output, to the communications port, the sample
  185.   string.  For example, the following Script Command outputs, to the
  186.   communications port, the string "BIX" followed by an ASCII Carriage
  187.   Return:
  188.  
  189.      Puts "BIX\r"
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.   The Screen Command
  203.  
  204.   The Screen command is used to control the display of characters in the CL
  205.   Window.  There are three options for the Screen command and they are:
  206.   "Clear", "Off", and "On".  Clear will clear the Communication Link Window,
  207.   Off will turn off the display of characters in the Communication Link
  208.   Window, and On will turn on the display of characters.  For example, the
  209.   following Script Command clears the Communication Link Window:
  210.  
  211.      Screen "CLEAR"
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.   The Show Command
  223.  
  224.   The Show command is used to display a string of characters in the
  225.   Communication Link Window.  The string is not transmitted.  For example,
  226.   the following Script Command displays the string "Start Of Blink" in the
  227.   Communication Link Window:
  228.  
  229.      Show "Start Of Blink\n"
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.   The Silence Command
  243.  
  244.   The Silence command is used to halt the execution of a Command Script
  245.   until the Communication Link detects the indicated number of seconds of
  246.   silence.  For example, the following Script Command will halt execution
  247.   until the Communication Link detects 6 seconds of silence:
  248.  
  249.      Silence "6"
  250.  
  251.   The Communication Link will display a prompt in the bottom status line of
  252.   the Communication Link Window advising you that it is currently waiting
  253.   for sample seconds of silence.  You may abort the wait by pressing <^C>.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.   The Wait Command
  263.  
  264.   The Wait command is used to halt the execution of a Command Script for
  265.   sample number of seconds.  For example, the following Script Command will
  266.   halt the execution of a Command Script for 2 seconds:
  267.  
  268.      Wait "2"
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.   The Watch Command
  283.  
  284.   The Watch command allows the user to tell the Communication Link to
  285.   perform a series of commands if a particular string is found in the input
  286.   stream. The syntax of the Watch command is:
  287.  
  288.      Watch_Start
  289.         command
  290.         ...
  291.         Watch_00 "String 1 to watch for"
  292.            command
  293.            ...
  294.         Watch_01 "String 2 to watch for"
  295.            command
  296.            ...
  297.         Watch_Del_00
  298.         Watch_Del_01
  299.      Watch_End
  300.  
  301.  
  302.   The Watch Command (Continued)
  303.  
  304.   Where:
  305.  
  306.      Watch_Start:
  307.  
  308.         Marks the beginning of the watch statement.  All commands, such as
  309.         Gets, Puts, etc., that are encountered between the Watch_Start and
  310.         the first Watch_xx statement are executed.  The Communication Link
  311.         will, upon encountering the first Watch_xx statement, load all the
  312.         strings that are to be watched for and immediately start watching
  313.         the input stream for all the strings. The Watch command will
  314.         continue to watch the input stream until *ALL* watches have been
  315.         deleted.
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.   The Watch Command (Continued)
  323.  
  324.      Watch_00 - Watch_09:
  325.  
  326.         Adds a string to the watch list. The Communication Link can handle
  327.         up to ten strings per watch statement.  The string lengths are not
  328.         limited.  The strings can include C escape sequences such as "\r",
  329.         "\n", and "\xnn". All watches are case-sensitive!
  330.  
  331.         If the Communication  Link detects a string of characters from the
  332.         input stream that matches a watch string, all commands between the
  333.         Watch_xx command that inserted the string into the watch list and
  334.         the next Watch_xx or Watch_end statements are executed.
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.   The Watch Command (Continued)
  343.  
  344.      Command:
  345.  
  346.         Can be any Comm Link Command Script command with the exception of
  347.         the Watch command -- Watches can *NOT* be nested.
  348.  
  349.      Watch_Del_00 - Watch_Del_09:
  350.  
  351.         Removes a string from the watch list.
  352.  
  353.         NOTE: *ALL* watches *MUST* be deleted to terminate the Watch
  354.         command.
  355.  
  356.      Watch_End:
  357.  
  358.         Marks the end of the Watch command.  *ALL* Watch commands *MUST* end
  359.         with a Watch_End statement.
  360.  
  361.